home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / rlog_130.zip / REMOTLOG.DOC < prev    next >
Text File  |  1991-01-10  |  20KB  |  521 lines
  1.                                     
  2.  
  3.  
  4.  
  5.                          R E M O T E   A C C E S S
  6.  
  7.  
  8.                   L O G  R E P O R T I N G  P R O G R A M
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                                 REMOTLOG
  15.  
  16.    //////    /////  /      /  ///////  ///////   /        ///////  ///////
  17.    /     /   /      / /   //  /     /     /      /        /     /  /
  18.    //////    ///    /   /  /  /     /     /      /        /     /  /   ///
  19.    /     /   /      /      /  /     /     /      /        /     /  /     /
  20.    /      /  /////  /      /  ///////     /      ///////  ///////  ///////
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67. The Program  - Remotlog
  68.  
  69.  
  70.         I developed Remotlog because when the announcement of RA was made and I
  71.         endeavored to switch from QuickBBS.  There was something missing.  I
  72.         could no longer use all my QBBS utilities.  After exhaustive efforts of
  73.         trying to get the implementation of my old program by its author, I
  74.         decided that it was time to do some coding.
  75.  
  76.         Here we have the finished product.  A full fledged RA log reporting
  77.         program.  This program is in no way crippled.  And never will be.
  78.  
  79.  
  80.  
  81.         RA is the registered product of Continental Software.
  82.         QuickBBS is the registered product of The QuickBBS Support Group or whatever it is now adays.
  83.  
  84.  
  85.         At present this program will function with RA version 0.0X.
  86.  
  87.         Do not attempt to use this program with any other software except RA
  88.         because it uses the file MESSAGES.RA.  If it cannot find this file the
  89.         program will abort in error.
  90.  
  91.         The screens provided by this program are as the author thought you
  92.         the sysops would like to see.  If you feel the information is too much
  93.         or that there is not enough, or would even like to see some of the
  94.         information moved from one location to another part of the page or a
  95.         totaly different screen.  Please do not hesitate to let the author
  96.         know.
  97.  
  98.  
  99.  
  100.  
  101. Configuration of Remotlog
  102.  
  103.    This is exactly as it appears in the Configuration file.  If you haven't
  104.    unzipped it.  It would behove you to do so.  And use it.  RTFM is now in
  105.    effect.
  106.  
  107. ;-------------------------------------------------------------------------
  108. ;                       Remotlog Configuration file
  109. ;                        By Orland Carter 1:135/72
  110. ;-------------------------------------------------------------------------
  111. ;
  112. ;-------------------------------------------------------------------------
  113. ;               R E G I S T R A T I O N   I N F O R M A T I O N
  114. ;-------------------------------------------------------------------------
  115. ;         {______________________________}
  116. BoardName  Opa-Locka Tower
  117. ;         {____________________}
  118. SysopName  Orland Carter
  119. RegistKey  00000000000000000000
  120. ;
  121. ;-------------------------------------------------------------------------
  122. ; This is a required entry.  It tells the program the [path + filename] of
  123. ; the Log file to be processed.
  124. ; DEFAULT : SYSTEM.LOG
  125. ;-------------------------------------------------------------------------
  126. ;
  127. LogFile SYSTEM.LOG
  128. ;
  129. ;-------------------------------------------------------------------------
  130. ; This entry is not required if you are only running single line system.
  131. ; If you are running Multi-Line and want to delete or zip each lines separate
  132. ; log files then this is needed.  LINEINUSE ##.  Where ## is the line being
  133. ; processed by this configuration file.  ## range is 1..99
  134. ;-------------------------------------------------------------------------
  135. ;
  136. LineInUse 1
  137. ;
  138. ;-------------------------------------------------------------------------
  139. ; This option is required if you want REMOTLOG to process the file Xfers
  140. ; against the files counter for a good downloaded count.  The DEFAULT is
  141. ; NOFDLOGFILE  the other option is FDLOGFILE \.......\  where \..\ is the
  142. ; [Path + Filename] of the FD log file.
  143. ;-------------------------------------------------------------------------
  144. ;
  145. FDLogFile C:\Fd\Fd.Log
  146. ;
  147. ;-------------------------------------------------------------------------
  148. ; This option is required.  It tells the program what the Dos Shell entry
  149. ; of your External chat program is.  This must be the same case as the
  150. ; BBS writes it to the log file.  Required whether you have one or not.
  151. ; DEFAULT : FX-CHAT.EXE
  152. ;-------------------------------------------------------------------------
  153. ;
  154. ExternalChat FastChat.EXE
  155. ;
  156. ;-------------------------------------------------------------------------
  157. ; This option is required.  It tells the program what [path + filename]
  158. ; the output of the program should be placed in. *.asc/*.ans versions.
  159. ; DEFAULT : REMOTLOG
  160. ;-------------------------------------------------------------------------
  161. ;
  162. Outputfile c:\RA\Txt\Remotlog
  163. ;
  164. ;-------------------------------------------------------------------------
  165. ; This option is required.  It tells the program which color to place the
  166. ; background of the ansi screen in.
  167. ; DEFAULT : 40
  168. ;-------------------------------------------------------------------------
  169. ;
  170. Back 40
  171. ;
  172. ;-------------------------------------------------------------------------
  173. ; This option is required.  It tells the program what color the numbers
  174. ; displayed are.
  175. ; DEFAULT : 1;33
  176. ;-------------------------------------------------------------------------
  177. ;
  178. Numbers 1;33
  179. ;
  180. ;-------------------------------------------------------------------------
  181. ; This option is required.  It tells the program what color to use when
  182. ; highlighting the Beginning and Ending dates of the Log period.
  183. ; DEFAULT : 1;46;37
  184. ;-------------------------------------------------------------------------
  185. ;
  186. HighLight 1;46;37
  187. ;
  188. ;-------------------------------------------------------------------------
  189. ; This option is required.  It tells the program which color to use to
  190. ; restore the screen to "normal".
  191. ; DEFAULT : 0
  192. ;-------------------------------------------------------------------------
  193. ;
  194. Normal 0
  195. ;
  196. ;-------------------------------------------------------------------------
  197. ; This option is required.  It tells the program which color to use for
  198. ; Outlining the Box and Dividing lines of the output file.
  199. ; DEFAULT 1;34
  200. ;-------------------------------------------------------------------------
  201. ;
  202. Outline 1;34
  203. ;
  204. ;-------------------------------------------------------------------------
  205. ; This option is required.  It tells the program which color to use for
  206. ; all the text that is printed.
  207. ; DEFAULT 0;32
  208. ;-------------------------------------------------------------------------
  209. ;
  210. Text 0;32
  211. ;
  212. ;-------------------------------------------------------------------------
  213. ; This option is required.  It tells the program whether or not you wish
  214. ; the optional page of Multiline usage to be displayed.  The statistics
  215. ; will still be stored if the option is not selected.
  216. ; DEFAULT : NOMULTILINE
  217. ;-------------------------------------------------------------------------
  218. ;
  219. NoMultiLine
  220. ;
  221. ;-------------------------------------------------------------------------
  222. ; This option is required.  It telss the program what type of log file
  223. ; You are using.  Wheter FD [Front Door type] or OPUS.
  224. ; DEFAULT FD
  225. ;-------------------------------------------------------------------------
  226. ;
  227. FD
  228. ;
  229. ;-------------------------------------------------------------------------
  230. ; This option is not required and at the descretion of the sysop.  Using
  231. ; This will cause another page to be displayed in addition to the current
  232. ; 2 or 3 pages that are already displayed.  This option is where the sysop
  233. ; Can have remotlog search the logfile for something specific and keep
  234. ; track of its occurrences.
  235. ; I.e. *01My_Name Carter      - This will cause remotlog to search the log
  236. ; file for all occurences of "Carter" it will accumulate and store the
  237. ; amount of time it finds it in variable 01.  When it displays it it will
  238. ; display "My_Name >>> ####" where # is amount of times the item was found
  239. ; Possible Variables are 00-29.  The 0 is significant.  The "*" is required
  240. ; There can be no spaces except to separate the Display item from the
  241. ; Search item.
  242. ; Format "*<Variable 00-29><Entry to Make in *.Ans/*.Asc file> <Search For>"
  243. ;         *00My_Name Carter
  244. ;-------------------------------------------------------------------------
  245. ;
  246. ;*00Graffitti_Wall  Grafn3.EXE
  247. ;*01JetFighter_Game Combat 1
  248. ;
  249. ;-------------------------------------------------------------------------
  250. ; These options are not required.  But they do provide you with a great
  251. ; amount of security.  For areas you do not want all your users to see.
  252. ; IE. Adult areas or Sysop areas.  (Message Areas)
  253. ; DEFAULT - NONE.  200 MAXIMUM ENTRIES.
  254. ;-------------------------------------------------------------------------
  255. ;
  256. NoShow  8
  257. NoShow 10
  258. NoShow 12
  259. ;
  260. ;-------------------------------------------------------------------------
  261. ; These options are not required.  But they do provide you with a great
  262. ; amount of security.  For areas you do not want all your users to see.
  263. ; IE. Adult areas or Sysop areas.  (File Areas)
  264. ; DEFAULT - NONE.  200 MAXIMUM ENTRIES.
  265. ;-------------------------------------------------------------------------
  266. ;
  267. NoFile  8
  268. NoFile 10
  269. NoFile 12
  270. ;
  271. ;-------------------------------------------------------------------------
  272. ; This option is not required.  It is used to Change the default Sealink
  273. ; protocol displayed in the 1st output page to a protocol of your choosing.
  274. ; REPLACESEA - Is the Search String for the new protocol.
  275. ; REPLACEDSP - Is the Actual Item to be displayed in the Output page.
  276. ;-------------------------------------------------------------------------
  277. ;
  278. ;ReplaceSea SEALink
  279. ;ReplaceDsp SEALink
  280. ;
  281. ;-------------------------------------------------------------------------
  282. ; This option is also not required.  It determines whether or not the local
  283. ; logons will be shown on the report output.  The DEFAULT for this option
  284. ; is show local logons.  Leave this option out for the default to take
  285. ; effect.
  286. ;-------------------------------------------------------------------------
  287. ;
  288. ;NoLocal
  289. ;
  290. ;-------------------------------------------------------------------------
  291. ; This option is also not required.  It activates or deactivates the
  292. ; Files.BBS downloaded files counter.  The count will be stored and added
  293. ; to the Files.BBS in the directory the file was taken from.  DEFAULT for
  294. ; This option is FILECOUNTER,     To deactivate use NOFILECOUNT
  295. ;-------------------------------------------------------------------------
  296. ;
  297. FILECOUNTER
  298. ;
  299. ;-------------------------------------------------------------------------
  300. ; This option is also not required.  It activates a chat record.  This will
  301. ; log all chats found in the log file to a file called REMOTLOG.CHT in the
  302. ; current directory.  The DEFAULT is CHATRECORD, all chats will be logged.
  303. ; The other option to disable the chat is NOCHATRECORD
  304. ; A file is created named REMOTLOG.CHT
  305. ;-------------------------------------------------------------------------
  306. ;
  307. CHATRECORD
  308. ;
  309. ;-------------------------------------------------------------------------
  310. ; This option is also not required.  It activates or Deactivates the log
  311. ; deleting option.  The DEFAULT is the log will be deleted every 10 days.
  312. ; The two options are DELTELOG ## (Where ## is days log should be kept.)
  313. ; and NODELETELOG.
  314. ;-------------------------------------------------------------------------
  315. ;
  316. DELETELOG 7
  317. ;
  318. ;-------------------------------------------------------------------------
  319. ; This option is also not required.  It activates or Deactivates the log
  320. ; deleting option.  The DEFAULT is the fd log will be deleted with the RA log.
  321. ; The two options are DELTEFDLOG and NODELETEFDLOG.
  322. ;-------------------------------------------------------------------------
  323. ;
  324. DELETEFDLOG
  325. ;
  326. ;-------------------------------------------------------------------------
  327. ; This option is also not required.  It will determine whether or not the
  328. ; Log file actually gets deleted/zipped/shrunk and/or given an individual date
  329. ; for storage.  The zip method used is PKZIP.  any version.  The file will
  330. ; be moved while zipped.  The zipped name will be in the format RLMMDDYY.ZIP
  331. ; This option will not function if the Delete log option is disabled.
  332. ; Pkzip must be in the current directory or properly pathed.
  333. ; DEFAULT - NOZIPFILE           other otion is ZIPFILE and SHRINKFILE
  334. ;-------------------------------------------------------------------------
  335. ;
  336. NOZIPFILE
  337. ;
  338. ;-------------------------------------------------------------------------
  339. ; This tells remotlog which message area to post the statistics files
  340. ; generated to.  A value of 0 here would cause remotlog to not post the
  341. ; files to the message area.  But will still accumulate information in
  342. ; Them.  This option is REQUIRED.
  343. ;-------------------------------------------------------------------------
  344. ;
  345. ;MessageBoard 3
  346. ;
  347. ;-------------------------------------------------------------------------
  348. ; This option is not required and defaults to Off.  It will determine if
  349. ; Remotlog will log a copy of all BBS downloads out to a file.  This file
  350. ; will be called Remotlog.Dwn  IT will be appended to.  To activate this
  351. ; option the Keyword is DOWNLOADS
  352. ;-------------------------------------------------------------------------
  353. ;
  354. ;Downloads
  355. ;
  356. ;-------------------------------------------------------------------------
  357. ;          E N D    O F    R E M O T L O G . C F G   F I L E
  358. ;-------------------------------------------------------------------------
  359.  
  360.  
  361. Here is a quick Batch file example to demonstrate the use of the Chat logging
  362. feature.
  363.  
  364. Batch File .........
  365.      MSTRDIR
  366.      ren mstrdir.cfg *.tmp     ; If you have MSTRDIR this can be used to handle
  367.      ren mstrdir.g   *.cfg     ; different security level type files listings.
  368.      MSTRDIR
  369.      ren mstrdir.cfg *.g
  370.      ren mstrdir.tmp *.cfg
  371. End Of Batch File....................
  372.  
  373.  
  374.  
  375.  
  376.  
  377. Supplied ANSI Code sequences
  378.  
  379. Number  Represents
  380. ------  ----------
  381. 0       All attributes off  (Normal Display)
  382.  
  383. 1       High Intensity (Bold)
  384.  
  385. 5       Sets Blink on
  386.  
  387. 7       Reverse Video on
  388.  
  389. 8       Concealed on (makes display invisible)
  390.  
  391. 30      Foreground      Black
  392.  
  393. 31                      Red
  394.  
  395. 32                      Green
  396.  
  397. 33                      Yellow
  398.  
  399. 34                      Blue on Color Monitor
  400.                         Underline on MonoChrome
  401.  
  402. 35                      Magenta
  403.  
  404. 36                      Cyan
  405.  
  406. 37                      White
  407.  
  408. 40      BackGround      Black
  409.  
  410. 41                      Red
  411.  
  412. 42                      Green
  413.  
  414. 43                      Yellow
  415.  
  416. 44                      Blue
  417.  
  418. 45                      Magenta
  419.  
  420. 46                      Cyan
  421.  
  422. 47                      White
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429. Hints about operation of this program
  430.  
  431.   There are several different things that you can do to get certain results
  432.   from this program.
  433.  
  434.    For example if you want to change the beging date of the report without
  435.    erasing the remotlog.dat file.  All you have to do is to edit the .DAT file
  436.    find the string that has the date in it and make it a null string.  When the
  437.    program starts up it will notice the date is missing and get the date from
  438.    the current system.log file.
  439.  
  440.    When reading the log file the program will not attempt to reposition pointers
  441.    if the last item in the log is that "REMOTLOG has checked the log."  Of course
  442.    the current session will be appended to the end of the logfile.
  443.  
  444.    By deleting the notations that REMOTLOG makes in the log file you can force
  445.    it to re-process the log file.
  446.  
  447.    The *##^^^^^^^^^ ___ option will accept hard spaces in the search for portion.
  448.    It is not restricted.
  449.  
  450.    If you want the sections that are used only with RA 1.0 to work with your
  451.    version of RA the following lines needs to be added to your menu for auto
  452.    logging to your logfile.
  453.  
  454.    "Reading message area #/M : `"
  455.    "Browsing file area #/F : @"
  456.  
  457.    Any bug reports, comments, or requested addition, deletions etc. may be sent
  458.    to Node 1:135/72.  or the addresses listed in the registration section.  I can
  459.    also be reached in the RA_SUPPORT and RA_UTIL echos.  Before you send me a
  460.    bug report if you are not registered and if you are.  Insure that you RTM
  461.    and read the configuration file comments before screaming bug report.  If you
  462.    send me netmail bug reports and are not registered do not wait for a netmail
  463.    reply.  It cost me money to send a net message back to you and you couldn't
  464.    find it to register.  All bug reports must contain a copy of Errors.log and
  465.    a summarized copy of your configuration file.  Meaning leave out all the lines
  466.    with a ";" in them.  Explain the bug in full detail.  If not I will simply
  467.    ignore it or send you a message indicating that I will take no action until
  468.    you can meet the bug report requirements.
  469.  
  470.  
  471.  
  472. Credits
  473.  
  474.    The author, Orland K. Carter, would like to thank my beta testers of
  475.    this program that put up with the constant updates to the one program and
  476.    major overhaul of their configuration and data files.
  477.  
  478.    To Peter Janssens a special thank you
  479.    and John Barton, Arturo Batista, Daniel Johnston, and Robert Taylor my
  480.    thanks you for your patience, and help in beta testing this program.
  481.  
  482.  
  483. Registrations
  484.  
  485.    The cost to register REMOTLOG is whatever you feel the program is worth.
  486.    From $5 and up. Registrations will be sent to.
  487.  ________________________________________________________________________
  488. |Registration of REMOTLOG,                    Form 1.50, U.Date 21 Dec 90|
  489. |------------------------------------------------------------------------|
  490. |                                                                        |
  491. |SysopName                                                               |
  492. |Name of Sysop __________________________________________________________|
  493. |                                                                        |
  494. |Street Address__________________________________________________________|
  495. |                                                                        |
  496. |City/St/Zip   __________________________________________________________|
  497. |                                                                        |
  498. |BoardName                                                               |
  499. |Name of BBS   __________________________________________________________|
  500. |                                                                        |
  501. |Number of BBS __________________________________________________________|
  502. |                                                                        |
  503. |Node #        __________________________________________________________|
  504. |                                                                        |
  505. |Make all payments address to                                            |
  506. |  Orland K. Carter, REMOTLOG                                            |
  507. |  2850 N.W. 155 Terrace                                                 |
  508. |  Opa-Locka, FL  33054-2223                                             |
  509. |________________________________________________________________________|
  510.  
  511. Thank you for your support.
  512.  
  513.         Orland
  514. Node 1:135/72   Fido Net
  515.      99:9005/18 EGGnet
  516.      55:0/0     CAPnet
  517.  
  518. Thank you for your support.
  519.  
  520.         Orland
  521.